Tangoe ServiceNow API

1.0.x
(0 reviews)

Case Comments API

Case comments can be created on a valid case (i.e. when a case is still in open or pending status or when a valid case is registered on Tangoe ServiceNow instance and a case number is retrieved). When a case comment is successfully created, the API returns a result key containing the full response payload, which typically contains keys like id, number, status.

Create a Case Comment

Request parameters

parameterrequired/optionaldescription
commentrequiredCase comment text

Example Request and Response

Note: - Below are example requests and responses, please use the appropriate base URL

REQUEST

curl "https://tangoe.service-now.com/api/tango/v1/integrations/cases/{number}/comments" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user 'admin':'admin' \
--data "{case_comment_object}"

sample case_comment_object:

{
  "comment": "some text comment goes here"
}

RESPONSE

HTTP/1.1 200 OK
Content-Type: application/json
{
  "result": {
    "id": "d194729ddb174850a813fd651d9619db",
    "number": "CS0618465",
    "status": "updated"
  }
}

Retrieving Case Comments

Case comments can be retrieved by passing the case number as a request parameter. Additionally, optional query parameters can be passed as listed below.

Query Parameters

parameterrequired/optionaldescription
limitoptionalThe maximum number of results returned per page (default: 10)
offsetoptionalOffset option specifies the number of items in the queried collection to be skip

Example Request and Response

Note: - Below are example requests and responses, please use the appropriate base URL

REQUEST

curl "https://tangoe.service- now.com/api/tango/v1/integrations/cases/{number}/comments" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

RESPONSE


HTTP/1.1 200 OK
Content-Type: application/json
{
  "result": [ {
    "id": "aa15a234dbd7c450a813fd651d961998",
    "comment": "some comment value again",
    "created_on": "2020-02-28 20:19:18",
    "created_by": "john.dow@tangoe.com"
  },
  {
    "id": "a9646af0dbd7c450a813fd651d9619e0",
    "comment": "some comment value later",
    "created_on": "2020-02-28 20:16:14",
    "created_by": "jane.dow@tangoe.com"
  },
  {
    "id": "4a2466f0dbd7c450a813fd651d96195c",
    "comment": "some comment value now",
    "created_on": "2020-02-28 20:15:11",
    "created_by": "steve.dow@tangoe.com"
  },
  {
    "id": "b8e81634db97c450a813fd651d9619ca",
    "comment": "comments 4",
    "created_on": "2020-02-28 19:25:56",
    "created_by": "john.dow@tangoe.com"
  },
  {...} // record skipped for readability purposes ]
}

Reviews